pp108 : Defining a Custom Schedule for Object Pruning

Defining a Custom Schedule for Object Pruning
This topic describes the procedure to define a custom schedule for the CWS Object Pruner.

Before you begin this task:

  • You must have the role of a System Administrator to perform this task. 
  • You must be able to access the configuration file, on the server where Process Platform is installed, to modify the configuration settings and control the schedule of the Object Pruner.

The Object Pruner removes database records that are marked as deleted by the CWS service container. Scheduling the Object Pruner at regular time intervals releases computer resources. 

Note: If you do not specify a custom time schedule, or define a faulty time schedule, the object pruner runs according to the default time schedule:

     5:00, 12:00, 20:00

The Object Pruner runs daily. In your custom time schedule you must specify time values in a 24-hour format:

  • 0 (=0:00)
  • 8 (=8:00)
  • 8:01
  • 23:00

To define a custom schedule:

  1. Open the file <Process Platform installation directory>\components\cws\config\cws.properties.
  2. Add the following code to the file:
    cleanup.cws.temporary.objects.schedule=<schedule>

    Note: You must replace <schedule> with your custom time schedule. For example, to run the Object Pruner each day at 3:00 and 23:30, add the following code: cleanup.cws.temporary.objects.schedule=3:00, 23:30

  3. Restart the CWS service container.

The custom schedule is defined.

If an invalid time schedule is provided, an error is displayed when the Service Container is started and the default time schedule is used instead. Examples of invalid schedules are:

  • cleanup.cws.temporary.objects.schedule=<empty>
  • cleanup.cws.temporary.objects.schedule=9:00,13:30,19:60